<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Strict//EN">
<html>
<head>
<meta http-equiv="Content-Language" content="en-us">
<title>IupItem</title>
<link rel="stylesheet" type="text/css" href="../../style.css">
<style type="text/css">
.style1 {
	margin-left: 40px;
}
</style>
</head>
<body>
<div id="navigation">
  <ul>
    <li><a href="#Creation">Creation</a></li>
    <li><a href="#Attributes">Attributes</a></li>
    <li><a href="#Callbacks">Callbacks</a></li>
    <li><a href="#Notes">Notes</a></li>
    <li><a href="#Examples">Examples</a></li>
    <li><a href="#SeeAlso">See Also</a></li>
  </ul>
</div>

<h2>IupItem</h2>

  <p>
  Creates an item of the menu interface element. When selected, it generates an action.</p>

<h3><a name="Creation">Creation</a></h3>
<pre>Ihandle* IupItem(const char *<strong>title</strong>, const char *<strong>action</strong>); [in C]
iup.item{[title = <strong>title</strong>: string]} -&gt; <strong>elem</strong>: ihandle [in Lua]
item(<strong>title</strong>, <strong>action</strong>) [in LED]</pre>
  <p><b>
  title</b>: Text to be shown on the item. It can be NULL. It will set the TITLE 
  attribute.<br>
  <b>
  action</b>: Name of the action generated when the item is selected. It can be NULL.</p>
  <p>
  <u>Returns:</u> the identifier of the 
  created element, or NULL if an error occurs.</p>

<h3><a name="Attributes">Attributes</a></h3>


<p><strong>AUTOTOGGLE</strong> (<font SIZE="3">non inheritable</font>): enables the automatic toggle of VALUE state when 
the item is activated. Default: NO. (since 3.0)</p>
<p><a href="../attrib/iup_key.html">KEY</a> (<font SIZE="3">non inheritable</font>): Underlines a key character in the submenu 
title. It 
is updated only when TITLE is updated. <strong>Deprecated (since 3.0)</strong>, use the 
mnemonic support directly in the TITLE attribute.</p>
<p><strong>HIDEMARK</strong> [Motif and GTK Only]: 
If enabled the item cannot be checked, since the check box will not be shown. If 
all items in a menu enable it, then no empty space will be shown in front of the 
items. 
Normally the unmarked check box will not be shown, but since GTK 2.14 the 
unmarked check box is always shown. If your item will not be marked you must set 
HIDEMARK=YES, since this is the most common case we changed the default value to 
YES for this version of GTK, but if VALUE is defined the default goes back to 
NO. Default: NO. (since 3.0)</p>
  <p><strong>IMAGE</strong> [Windows and GTK Only] (<font SIZE="3">non inheritable</font>): Image name of the check mark 
	image when 
	VALUE=OFF. 
  In Windows, an item in a menu bar cannot have a 
	check mark. Ignored if item in a menu bar. A recommended size would be 16x16 
	to fit the image in the menu item. In Windows, if larger than the check mark 
	area it will be cropped.</p>
  <p><strong>IMPRESS</strong> [Windows and GTK Only] (<font SIZE="3">non inheritable</font>): Image name of the check 
	mark image when VALUE=ON.</p>
<p><a href="../attrib/iup_title.html">TITLE</a> (<font SIZE="3">non inheritable</font>):
  Item text. The &quot;&amp;&quot; character can be used to 
	define a mnemonic, the next character will be used as key. Use &quot;&amp;&amp;&quot; to show the &quot;&amp;&quot; character instead on defining a 
	mnemonic. When in a menu bar an item that has a mnemonic can be activated from any control in the dialog using 
	the &quot;Alt+key&quot; combination.</p>
<p class="info">The text also accepts the 
  control character '\t' to force text alignment to the right after this character. This is used to add shortcut keys 
  to the menu, aligned to the right, ex: &quot;Save\tCtrl+S&quot;, but notice 
that the shortcut key (also known as Accelerator or Hot Key) still has to be 
implemented. To implement a shortcut use the K_* callbacks in the dialog.</p>


  <p><strong>TITLEIMAGE</strong> (<font SIZE="3">non inheritable</font>): Image name of the title image. In Windows, it 
	appears before of the title text and after the check mark area (so both 
	title and title image can be visible). In Motif, it must be at least defined 
	during map, it replaces the text, and only images will be possible to set 
	(TITLE will be hidden). In GTK, it will appear on the check mark area. 
	(since 3.0)</p>
<p><b>VALUE</b> (<font SIZE="3">non inheritable</font>):
  Indicates the item's state. When the value 
  is ON, a mark will be displayed to the left of 
  the item. Default: OFF. An item in a menu bar cannot have a check 
	mark. When IMAGE is used, the checkmark is 
	not shown. See the item AUTOTOGGLE attribute and the menu
<a href="iupmenu.html#RADIO">RADIO</a> attribute.</p>


  <p> <a href="../attrib/iup_wid.html">WID</a> (<font SIZE="3">non inheritable</font>): In Windows, returns the HMENU of 
	the parent menu.</p>


  <blockquote>
    <hr>
</blockquote>
<p>
<a href="../attrib/iup_active.html">ACTIVE</a>: 
also accepted.</p>

<h3><a name="Callbacks">Callbacks</a></h3>

<p><a href="../call/iup_action.html">ACTION</a>:
  Action generated when the item is selected. IUP_CLOSE will be processed. Even 
if inside a popup menu when IUP_CLOSE is returned, the current popup dialog or 
the main loop will be closed.</p>
  <p><a href="../call/iup_highlight_cb.html">HIGHLIGHT_CB</a>:
  Action generated when the item is 
  highlighted.</p>
    <hr class="style1">

<p> 
<a href="../call/iup_map_cb.html">MAP_CB</a>, 
<a href="../call/iup_unmap_cb.html">UNMAP_CB</a>, 
<a href="../call/iup_help_cb.html">HELP_CB</a>: common callbacks are 
supported.</p>

<h3><a name="Notes">Notes</a></h3>

  <p>Menu items are activated using the Enter key.</p>
<p>In Motif and GTK, the text font will be affected by the dialog font when the menu is 
mapped.</p>
<p>Since GTK 2.14 to have a menu item that can be marked you must set the VALUE 
attribute to ON or OFF, or set HIDEMARK=NO, before mapping the control.</p>

<h3><a name="Examples">Examples</a></h3>
<p><a href="../../examples/">Browse for Example Files</a></p>
<p>See the <strong>IupMenu</strong> element for screenshots.</p>
<h3><a name="SeeAlso">See Also</a></h3>

<p><a href="iupseparator.html">IupSeparator</a>, <a href="iupsubmenu.html">IupSubmenu</a>,
  <a href="iupmenu.html">IupMenu</a>.</p>


</body>

</html>